Node / meshtastic / Meshtastic-Android / files / core / nfc / README.md

Displaying Raw • View rendered • Download

Tc9d1d9# `:core:nfc`

Tc9d1d9## Overview

The Ta5d6ff`:core:nfc` module provides Near Field Communication (NFC) capabilities for the application. It is a KMP module with Android NFC hardware implementation isolated to Ta5d6ff`androidMain`. The shared NFC contract is provided via Ta5d6ff`LocalNfcScannerProvider` in Ta5d6ff`core:ui`.

Tc9d1d9## Key Components

Tc9d1d9### 1. `NfcScannerEffect` (androidMain)

A Composable side-effect that manages Android NFC adapter state and listens for NDEF tags. Located in Ta5d6ff`androidMain` since NFC hardware APIs are Android-specific.

Tc9d1d9### 2. `LocalNfcScannerProvider` (core:ui/commonMain)

The shared capability contract for NFC scanning, injected via Ta5d6ff`CompositionLocalProvider` from the app layer.

Tc9d1d9## Dependency Graph

<!--region graph-->

Ta5d6ff```Ta5d6ffmermaid

Ta5d6ffgraph TB

:core:nfc[nfc]:::kmp-library-compose

classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef android-application-compose fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef compose-desktop-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;

classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;

classDef android-library-compose fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;

classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000;

classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-library-compose fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-library fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;

classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000;

Ta5d6ff```

<!--endregion-->